AcsServerProcess Class Reference

AcsServerProcess holds and manipulates the ACS server process. More...

Inheritance diagram for AcsServerProcess:

Public Member Functions
bool	addToUserMap (string, string, string)
	Adds a user record with the specified username, description, and password. More...
void	deleteFromUserMap (string)
	Removes the user record with the specified username, description, and password. More...
bool	addToClientMap (ip, Aaa::EAcsServerType, string, string)
	Adds a client with the specified IP address, server type, name, and password. More...
void	deleteFromClientMap (ip, Aaa::EAcsServerType)
	Removes the client with the specified username, description, and password. More...
void	enableACSServerService (bool)
	Removes the client with the specified username, description, and password. More...
bool	isEnabled ()
	Returns true if the ACS service is enabled, otherwise false. More...
vector< string >	getUserRecordsAsString ()
	Returns a vector of all user records in string format: key:username,password,description. More...
vector< string >	getClientRecordsAsString ()
	Returns a vector of all client records in string format: key:username,password,description. More...
void	removeAllUserRecords ()
void	removeAllClientRecords ()
Public Member Functions inherited from Process
Device	getOwnerDevice ()
	Returns the device for this process. More...

Detailed Description

AcsServerProcess holds and manipulates the ACS server process.

Member Function Documentation

addToClientMap()

bool AcsServerProcess::addToClientMap	(	ip	,
		Aaa::EAcsServerType	,
		string	,
		string
	)

Adds a client with the specified IP address, server type, name, and password.

Parameters

hostIp,the	IP address of the client.
serverType,the	type of server. Server types: eTacacsServer = 0, eRadiusServer = 1
name,the	name of the client.
keyStr,the	secret key for the client.

Returns

bool, true if client added successfully, otherwise false.

addToUserMap()

bool AcsServerProcess::addToUserMap	(	string	,
		string	,
		string
	)

Adds a user record with the specified username, description, and password.

Parameters

userName,the	username of the user record to add.
description,the	description of the user record to add.
password,the	password of the user record to add.

Returns

bool, true if user record added successfully, otherwise false.

deleteFromClientMap()

void AcsServerProcess::deleteFromClientMap	(	ip	,
		Aaa::EAcsServerType
	)

Removes the client with the specified username, description, and password.

Parameters

hostIp,the	IP address of the client.
serverType,the	type of server. Server types: eTacacsServer = 0, eRadiusServer = 1
name,the	name of the client.
keyStr,the	secret key for the client.

Returns

bool, true if client removed successfully, otherwise false.

deleteFromUserMap()

void AcsServerProcess::deleteFromUserMap

(

string

)

Removes the user record with the specified username, description, and password.

Parameters

userName,the

username of the user record to remove.

enableACSServerService()

void AcsServerProcess::enableACSServerService

(

bool

)

Removes the client with the specified username, description, and password.

Parameters

status,true

enables the ACS service, false disables it.

getClientRecordsAsString()

vector< string > AcsServerProcess::getClientRecordsAsString

(

)

Returns a vector of all client records in string format: key:username,password,description.

Returns

Returns a vector of all user records in string format: key:description,server_type_as_integer,hostip,keystring Server type = eTacacsServer=0, Server type = eRadiusServer=1

getUserRecordsAsString()

vector< string > AcsServerProcess::getUserRecordsAsString

(

)

Returns a vector of all user records in string format: key:username,password,description.

Returns

Returns a vector of all user records in string format: key:username,password,description

isEnabled()

bool AcsServerProcess::isEnabled

(

)

Returns true if the ACS service is enabled, otherwise false.

Returns

bool, true if the ACS service is enabled, otherwise false.

removeAllClientRecords()

void AcsServerProcess::removeAllClientRecords

(

)

removeAllUserRecords()

void AcsServerProcess::removeAllUserRecords

(

)

---

The documentation for this class was generated from the following file:

• CAcsServerProcess.pki